Sibly-Chat-App is a chat application designed for seamless communication between friends. It consists of two main components: sibly-api and sibly-ui.
-
Search Friends: Users can search for friends within the application to connect and communicate with them.
-
Send and Receive Friend Requests: Users can send friend requests to others and accept or decline incoming friend requests.
-
Chat with Friends: Once connected, users can engage in text-based conversations with their friends.
-
Video Call: Sibly-Chat-App allows users to make video calls to their friends for face-to-face communication.
The sibly-api
folder contains the backend logic and API endpoints necessary for the application to function. This includes handling user authentication, friend requests, messaging, and video call functionalities.
The sibly-ui
folder houses the frontend components and user interface elements of the application. It is responsible for rendering the user interface, handling user interactions, and making requests to the backend API.
To set up and run the Sibly-Chat-App on your local machine, follow these steps:
-
Clone the Repository:
git clone <repository_url>
-
Install Dependencies:
- Navigate to the
sibly-api
directory and install the dependencies:cd sibly-api npm install
- Navigate to the
sibly-ui
directory and install the dependencies:cd sibly-ui npm install
- Navigate to the
-
Configure Environment Variables:
- Set up environment variables for the API server, such as database connection details, JWT secret, etc., in the
sibly-api/.env
file.
- Set up environment variables for the API server, such as database connection details, JWT secret, etc., in the
-
Start the Servers:
-
Start the API server:
cd sibly-api npm start
-
Start the UI server:
cd sibly-ui npm start
-
-
Access the Application:
Once both servers are running, you can access the Sibly-Chat-App by opening a web browser and navigating to
http://localhost:3000
.
We plan to incorporate the following features and improvements in future updates:
- Group chat functionality
- File sharing capabilities
- Integration with third-party authentication providers
- Enhanced security measures
- Improved user interface and user experience
Contributions to Sibly-Chat-App are welcome! If you'd like to contribute, please follow these guidelines:
- Fork the repository
- Create a new branch for your feature or bug fix
- Make your changes and ensure all tests pass
- Submit a pull request detailing your changes
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to reach out if you have any questions or need further assistance with the Sibly-Chat-App!